home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1998 April: Mac OS SDK / Dev.CD Apr 98 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Universal / Interfaces / AIncludes / OSUtils.a < prev    next >
Encoding:
Text File  |  1998-02-12  |  12.2 KB  |  499 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        OSUtils.a
  3. ;
  4. ;    Contains:    OS Utilities Interfaces.
  5. ;
  6. ;    Version:    Technology:    Mac OS 8
  7. ;                Release:    Universal Interfaces 3.1
  8. ;
  9. ;    Copyright:    © 1985-1998 by Apple Computer, Inc., all rights reserved
  10. ;
  11. ;    Bugs?:        Please include the the file and version information (from above) with
  12. ;                the problem description.  Developers belonging to one of the Apple
  13. ;                developer programs can submit bug reports to:
  14. ;
  15. ;                    devsupport@apple.com
  16. ;
  17. ;
  18.     IF &TYPE('__OSUTILS__') = 'UNDEFINED' THEN
  19. __OSUTILS__ SET 1
  20.  
  21.     IF &TYPE('__MACTYPES__') = 'UNDEFINED' THEN
  22.     include 'MacTypes.a'
  23.     ENDIF
  24.     IF &TYPE('__MIXEDMODE__') = 'UNDEFINED' THEN
  25.     include 'MixedMode.a'
  26.     ENDIF
  27. ;   HandToHand and other memory utilties were moved to MacMemory.h 
  28.     IF &TYPE('__MACMEMORY__') = 'UNDEFINED' THEN
  29.     include 'MacMemory.a'
  30.     ENDIF
  31. ;   GetTrapAddress and other trap table utilties were moved to Patches.h 
  32.     IF &TYPE('__PATCHES__') = 'UNDEFINED' THEN
  33.     include 'Patches.a'
  34.     ENDIF
  35. ;   Date and Time utilties were moved to DateTimeUtils.h 
  36.     IF &TYPE('__DATETIMEUTILS__') = 'UNDEFINED' THEN
  37.     include 'DateTimeUtils.a'
  38.     ENDIF
  39.     IF ¬ TARGET_OS_MAC THEN
  40.     IF &TYPE('__ENDIAN__') = 'UNDEFINED' THEN
  41.     include 'Endian.a'
  42.     ENDIF
  43.     ENDIF
  44.  
  45. useFree                            EQU        0
  46. useATalk                        EQU        1
  47. useAsync                        EQU        2
  48. useExtClk                        EQU        3                    ;Externally clocked
  49. useMIDI                            EQU        4
  50.  
  51. false32b                        EQU        0                    ;24 bit addressing error
  52. true32b                            EQU        1                    ;32 bit addressing error
  53.  
  54.                                                             ; result types for RelString Call 
  55. sortsBefore                        EQU        -1                    ;first string < second string
  56. sortsEqual                        EQU        0                    ;first string = second string
  57. sortsAfter                        EQU        1                    ;first string > second string
  58.  
  59. dummyType                        EQU        0
  60. vType                            EQU        1
  61. ioQType                            EQU        2
  62. drvQType                        EQU        3
  63. evType                            EQU        4
  64. fsQType                            EQU        5
  65. sIQType                            EQU        6
  66. dtQType                            EQU        7
  67. nmType                            EQU        8
  68. ; typedef SignedByte                     QTypes
  69.  
  70. SysParmType                RECORD 0
  71. valid                     ds.b    1                ; offset: $0 (0)
  72. aTalkA                     ds.b    1                ; offset: $1 (1)
  73. aTalkB                     ds.b    1                ; offset: $2 (2)
  74. config                     ds.b    1                ; offset: $3 (3)
  75. portA                     ds.w    1                ; offset: $4 (4)
  76. portB                     ds.w    1                ; offset: $6 (6)
  77. alarm                     ds.l    1                ; offset: $8 (8)
  78. font                     ds.w    1                ; offset: $C (12)
  79. kbdPrint                 ds.w    1                ; offset: $E (14)
  80. volClik                     ds.w    1                ; offset: $10 (16)
  81. misc                     ds.w    1                ; offset: $12 (18)
  82. sizeof                     EQU *                    ; size:   $14 (20)
  83.                         ENDR
  84. ; typedef struct SysParmType *            SysPPtr
  85.  
  86. QElem                    RECORD 0
  87. qLink                     ds.l    1                ; offset: $0 (0)
  88. qType                     ds.w    1                ; offset: $4 (4)
  89. qData                     ds.w    1                ; offset: $6 (6) <-- really an array of length one
  90. sizeof                     EQU *                    ; size:   $8 (8)
  91.                         ENDR
  92. ; typedef struct QElem *                QElemPtr
  93.  
  94.     IF TARGET_OS_MAC THEN
  95. QHdr                    RECORD 0
  96. qFlags                     ds.w    1                ; offset: $0 (0)
  97. qHead                     ds.l    1                ; offset: $2 (2)
  98. qTail                     ds.l    1                ; offset: $6 (6)
  99. sizeof                     EQU *                    ; size:   $A (10)
  100.                         ENDR
  101. ; typedef struct QHdr *                    QHdrPtr
  102.  
  103.     ELSE
  104.  
  105. ;   QuickTime 3.0:
  106. ;   this version of QHdr contains the Mutex necessary for
  107. ;   non-mac non-interrupt code
  108.  
  109.  
  110. QHdr                    RECORD 0
  111. qFlags                     ds.w    1                ; offset: $0 (0)
  112. pad                         ds.w    1                ; offset: $2 (2)
  113. MutexID                     ds.l    1                ; offset: $4 (4)
  114. qHead                     ds.l    1                ; offset: $8 (8)
  115. qTail                     ds.l    1                ; offset: $C (12)
  116. sizeof                     EQU *                    ; size:   $10 (16)
  117.                         ENDR
  118. ; typedef struct QHdr *                    QHdrPtr
  119.  
  120.     ENDIF    ; TARGET_OS_MAC
  121.  
  122.  
  123. DeferredTask            RECORD 0
  124. qLink                     ds.l    1                ; offset: $0 (0)
  125. qType                     ds.w    1                ; offset: $4 (4)
  126. dtFlags                     ds.w    1                ; offset: $6 (6)
  127. dtAddr                     ds.l    1                ; offset: $8 (8)
  128. dtParam                     ds.l    1                ; offset: $C (12)
  129. dtReserved                 ds.l    1                ; offset: $10 (16)
  130. sizeof                     EQU *                    ; size:   $14 (20)
  131.                         ENDR
  132. ; typedef struct DeferredTask *            DeferredTaskPtr
  133.  
  134.     IF TARGET_OS_MAC THEN
  135. MachineLocation            RECORD 0
  136. latitude                 ds.l    1                ; offset: $0 (0)
  137. longitude                 ds.l    1                ; offset: $4 (4)
  138. dlsDelta                 ds.b    1                ; offset: $8 (8)        ;  signed byte; daylight savings delta 
  139.                          ORG 8
  140. gmtDelta                 ds.l    1                ; offset: $8 (8)        ;  use low 24-bits only 
  141. sizeof                     EQU *                    ; size:   $C (12)
  142.                         ENDR
  143.     ELSE
  144. ; 
  145. ;    QuickTime 3.0:
  146. ;    Alignment of MachineLocation is weird. The union above used for delta
  147. ;    tends not to work on non-Mac compilers.
  148. ;
  149.  
  150. MachineLocation            RECORD 0
  151. latitude                 ds.l    1                ; offset: $0 (0)
  152. longitude                 ds.l    1                ; offset: $4 (4)
  153. delta                     ds        BigEndianLong    ; offset: $8 (8)        ;  high byte is daylight savings delta, low 24-bits is GMT delta 
  154. sizeof                     EQU *                    ; size:   $C (12)
  155.                         ENDR
  156.     ENDIF    ; TARGET_OS_MAC
  157. ;
  158. ; pascal Boolean IsMetric(void )
  159. ;
  160.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  161.         Macro
  162.         _IsMetric
  163.             move.w              #$0004,-(sp)
  164.             dc.w                $A9ED
  165.         EndM
  166.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  167.         IMPORT_CFM_FUNCTION IsMetric
  168.     ENDIF
  169.  
  170. ;
  171. ; pascal SysPPtr GetSysPPtr(void )
  172. ;
  173.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  174.         Macro
  175.         _GetSysPPtr           &dest=(sp)
  176.             move.l            #$000001F8,&dest
  177.         EndM
  178.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  179.         IMPORT_CFM_FUNCTION GetSysPPtr
  180.     ENDIF
  181.  
  182.  
  183. ; 
  184. ;    NOTE: SysBeep() has been moved to Sound.h.  
  185. ;          We could not automatically #include Sound.h in this file
  186. ;          because Sound.h indirectly #include's OSUtils.h which
  187. ;          would make a circular include.
  188. ;
  189.  
  190. ;
  191. ; pascal OSErr DTInstall(DeferredTaskPtr dtTaskPtr)
  192. ;
  193.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  194.         ; parameters:
  195.         ;    dtTaskPtr       => A0
  196.         ; returns:
  197.         ;    OSErr           <= D0
  198.         _DTInstall:    OPWORD    $A082
  199.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  200.         IMPORT_CFM_FUNCTION DTInstall
  201.     ENDIF
  202.  
  203.  
  204.  
  205. ;
  206. ; pascal SInt8 GetMMUMode(void)
  207. ;
  208.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  209.         Macro
  210.         _GetMMUMode           &dest=(sp)
  211.             move.b            $0CB2,&dest
  212.         EndM
  213.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  214.         IMPORT_CFM_FUNCTION GetMMUMode
  215.     ENDIF
  216.  
  217. ;
  218. ; pascal SInt8 SwapMMUMode(SInt8 mode)
  219. ;
  220.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  221.         ; parameters:
  222.         ;    mode            => D0
  223.         ; returns:
  224.         ;    SInt8           <= D0
  225.         _SwapMMUMode:    OPWORD    $A05D
  226.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  227.         IMPORT_CFM_FUNCTION SwapMMUMode
  228.     ENDIF
  229.  
  230. ;
  231. ; pascal void Delay(unsigned long numTicks, unsigned long *finalTicks)
  232. ;
  233.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  234.         _Delay:    OPWORD    $A03B
  235.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  236.         IMPORT_CFM_FUNCTION Delay
  237.     ENDIF
  238.  
  239.  
  240. ;
  241. ; pascal OSErr WriteParam(void )
  242. ;
  243.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  244.         _WriteParam:    OPWORD    $A038
  245.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  246.         IMPORT_CFM_FUNCTION WriteParam
  247.     ENDIF
  248.  
  249. ;
  250. ; pascal void Enqueue(QElemPtr qElement, QHdrPtr qHeader)
  251. ;
  252.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  253.         ; parameters:
  254.         ;    qElement        => A0
  255.         ;    qHeader         => A1
  256.         _Enqueue:    OPWORD    $A96F
  257.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  258.         IMPORT_CFM_FUNCTION Enqueue
  259.     ENDIF
  260.  
  261. ;
  262. ; pascal OSErr Dequeue(QElemPtr qElement, QHdrPtr qHeader)
  263. ;
  264.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  265.         ; parameters:
  266.         ;    qElement        => A0
  267.         ;    qHeader         => A1
  268.         ; returns:
  269.         ;    OSErr           <= D0
  270.         _Dequeue:    OPWORD    $A96E
  271.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  272.         IMPORT_CFM_FUNCTION Dequeue
  273.     ENDIF
  274.  
  275. ;
  276. ; pascal OSErr InitUtil(void )
  277. ;
  278.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  279.         ; returns:
  280.         ;    OSErr           <= D0
  281.         _InitUtil:    OPWORD    $A03F
  282.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  283.         IMPORT_CFM_FUNCTION InitUtil
  284.     ENDIF
  285.  
  286.  
  287.     IF TARGET_CPU_PPC THEN
  288. ;
  289. ; pascal void MakeDataExecutable(void *baseAddress, unsigned long length)
  290. ;
  291.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  292.         IMPORT_CFM_FUNCTION MakeDataExecutable
  293.     ENDIF
  294.  
  295.     ENDIF    ; TARGET_CPU_PPC
  296.     IF TARGET_CPU_68K THEN
  297. ;
  298. ; pascal Boolean SwapInstructionCache(Boolean cacheEnable)
  299. ;
  300.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  301.         Macro
  302.         _SwapInstructionCache
  303.             moveq               #0,D0
  304.             dc.w                $A098
  305.         EndM
  306.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  307.         IMPORT_CFM_FUNCTION SwapInstructionCache
  308.     ENDIF
  309.  
  310. ;
  311. ; pascal void FlushInstructionCache(void )
  312. ;
  313.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  314.         Macro
  315.         _FlushInstructionCache
  316.             moveq               #1,D0
  317.             dc.w                $A098
  318.         EndM
  319.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  320.         IMPORT_CFM_FUNCTION FlushInstructionCache
  321.     ENDIF
  322.  
  323. ;
  324. ; pascal Boolean SwapDataCache(Boolean cacheEnable)
  325. ;
  326.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  327.         Macro
  328.         _SwapDataCache
  329.             moveq               #2,D0
  330.             dc.w                $A098
  331.         EndM
  332.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  333.         IMPORT_CFM_FUNCTION SwapDataCache
  334.     ENDIF
  335.  
  336. ;
  337. ; pascal void FlushDataCache(void )
  338. ;
  339.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  340.         Macro
  341.         _FlushDataCache
  342.             moveq               #3,D0
  343.             dc.w                $A098
  344.         EndM
  345.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  346.         IMPORT_CFM_FUNCTION FlushDataCache
  347.     ENDIF
  348.  
  349. ;
  350. ; pascal void FlushCodeCache(void )
  351. ;
  352.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  353.         _FlushCodeCache:    OPWORD    $A0BD
  354.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  355.         IMPORT_CFM_FUNCTION FlushCodeCache
  356.     ENDIF
  357.  
  358. ;
  359. ; pascal OSErr FlushCodeCacheRange(void *address, unsigned long count)
  360. ;
  361.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  362.         ; parameters:
  363.         ;    address         => A0
  364.         ;    count           => A1
  365.         ; returns:
  366.         ;    OSErr           <= D0
  367.         Macro
  368.         _FlushCodeCacheRange
  369.             moveq               #9,D0
  370.             dc.w                $A098
  371.         EndM
  372.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  373.         IMPORT_CFM_FUNCTION FlushCodeCacheRange
  374.     ENDIF
  375.  
  376. ;
  377. ; pascal void FlushExternalCache(void )
  378. ;
  379.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  380.         Macro
  381.         _FlushExternalCache
  382.             moveq               #6,D0
  383.             dc.w                $A098
  384.         EndM
  385.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  386.         IMPORT_CFM_FUNCTION FlushExternalCache
  387.     ENDIF
  388.  
  389.     ENDIF    ; TARGET_CPU_68K
  390. ;
  391. ; pascal void ReadLocation(MachineLocation *loc)
  392. ;
  393.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  394.         ; parameters:
  395.         ;    loc             => A0
  396.         Macro
  397.         _ReadLocation
  398.             move.l              #$000C00E4,D0
  399.             dc.w                $A051
  400.         EndM
  401.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  402.         IMPORT_CFM_FUNCTION ReadLocation
  403.     ENDIF
  404.  
  405. ;
  406. ; pascal void WriteLocation(const MachineLocation *loc)
  407. ;
  408.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  409.         ; parameters:
  410.         ;    loc             => A0
  411.         Macro
  412.         _WriteLocation
  413.             move.l              #$000C00E4,D0
  414.             dc.w                $A052
  415.         EndM
  416.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  417.         IMPORT_CFM_FUNCTION WriteLocation
  418.     ENDIF
  419.  
  420.  
  421.  
  422.     IF OLDROUTINENAMES THEN
  423.     ENDIF    ; OLDROUTINENAMES
  424. ; 
  425. ;    NOTE: SysEnvirons is obsolete.  You should be using Gestalt.
  426. ;
  427.  
  428. ;  Environs Equates 
  429.  
  430. curSysEnvVers                    EQU        2                    ;Updated to equal latest SysEnvirons version
  431. SysEnvRec                RECORD 0
  432. environsVersion             ds.w    1                ; offset: $0 (0)
  433. machineType                 ds.w    1                ; offset: $2 (2)
  434. systemVersion             ds.w    1                ; offset: $4 (4)
  435. processor                 ds.w    1                ; offset: $6 (6)
  436. hasFPU                     ds.b    1                ; offset: $8 (8)
  437. hasColorQD                 ds.b    1                ; offset: $9 (9)
  438. keyBoardType             ds.w    1                ; offset: $A (10)
  439. atDrvrVersNum             ds.w    1                ; offset: $C (12)
  440. sysVRefNum                 ds.w    1                ; offset: $E (14)
  441. sizeof                     EQU *                    ; size:   $10 (16)
  442.                         ENDR
  443.  
  444.                                                             ; Machine Types 
  445. envMac                            EQU        -1
  446. envXL                            EQU        -2
  447. envMachUnknown                    EQU        0
  448. env512KE                        EQU        1
  449. envMacPlus                        EQU        2
  450. envSE                            EQU        3
  451. envMacII                        EQU        4
  452. envMacIIx                        EQU        5
  453. envMacIIcx                        EQU        6
  454. envSE30                            EQU        7
  455. envPortable                        EQU        8
  456. envMacIIci                        EQU        9
  457. envMacIIfx                        EQU        11
  458.  
  459.                                                             ; CPU types 
  460. envCPUUnknown                    EQU        0
  461. env68000                        EQU        1
  462. env68010                        EQU        2
  463. env68020                        EQU        3
  464. env68030                        EQU        4
  465. env68040                        EQU        5
  466.  
  467.                                                             ; Keyboard types 
  468. envUnknownKbd                    EQU        0
  469. envMacKbd                        EQU        1
  470. envMacAndPad                    EQU        2
  471. envMacPlusKbd                    EQU        3
  472. envAExtendKbd                    EQU        4
  473. envStandADBKbd                    EQU        5
  474. envPrtblADBKbd                    EQU        6
  475. envPrtblISOKbd                    EQU        7
  476. envStdISOADBKbd                    EQU        8
  477. envExtISOADBKbd                    EQU        9
  478. ;
  479. ; pascal OSErr SysEnvirons(short versionRequested, SysEnvRec *theWorld)
  480. ;
  481.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  482.         ; parameters:
  483.         ;    versionRequetheWorld=> D0
  484.         ;    theWorld        => A0
  485.         ; returns:
  486.         ;    OSErr           <= D0
  487.         _SysEnvirons:    OPWORD    $A090
  488.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  489.         IMPORT_CFM_FUNCTION SysEnvirons
  490.     ENDIF
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.     ENDIF ; __OSUTILS__ 
  498.  
  499.